Please Note:

You are not viewing the most recent version of this page. 3.20(SP1) is the latest version available.

PIN endpoints

GetRandomTokenPIN

GetRandomTokenPIN(System.String)

Get a random server side PIN that complies with the current server side PIN policy.

Parameters

Param: organization: Account

Returns

The random PIN

SOAP 1.1 sample

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

Request:

POST /bsidca/BSIDCA.asmx HTTP/1.1
Host: cloud.safenet-inc.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.cryptocard.com/blackshield/GetRandomTokenPIN"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <GetRandomTokenPIN xmlns="http://www.cryptocard.com/blackshield/">
      <organization>string</organization>
    </GetRandomTokenPIN>
  </soap:Body>
</soap:Envelope>

Response:

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <GetRandomTokenPINResponse xmlns="http://www.cryptocard.com/blackshield/">
      <GetRandomTokenPINResult>string</GetRandomTokenPINResult>
    </GetRandomTokenPINResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2 sample

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

Request:

POST /bsidca/BSIDCA.asmx HTTP/1.1
Host: cloud.safenet-inc.com
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <GetRandomTokenPIN xmlns="http://www.cryptocard.com/blackshield/">
      <organization>string</organization>
    </GetRandomTokenPIN>
  </soap12:Body>
</soap12:Envelope>

Response:

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <GetRandomTokenPINResponse xmlns="http://www.cryptocard.com/blackshield/">
      <GetRandomTokenPINResult>string</GetRandomTokenPINResult>
    </GetRandomTokenPINResponse>
  </soap12:Body>
</soap12:Envelope>

HTTP GET sample

The following is a sample HTTP GET request and response. The placeholders shown need to be replaced with actual values.

Request:

GET /bsidca/BSIDCA.asmx/GetRandomTokenPIN?organization=string HTTP/1.1
Host: cloud.safenet-inc.com

Response:

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<string xmlns="http://www.cryptocard.com/blackshield/">string</string>

HTTP POST sample

The following is a sample HTTP POST request and response. The placeholders shown need to be replaced with actual values.

Request:

POST /bsidca/BSIDCA.asmx/GetRandomTokenPIN HTTP/1.1
Host: cloud.safenet-inc.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length

organization=string

Response:

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<string xmlns="http://www.cryptocard.com/blackshield/">string</string>

GetServerPINPolicy

GetServerPINPolicy(System.String)

Get the server side PIN policy for tokens.

Parameter

Param: organization: Account

Returns

Server PIN policy

SOAP 1.1 sample

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

Request:

POST /bsidca/BSIDCA.asmx HTTP/1.1
Host: cloud.safenet-inc.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.cryptocard.com/blackshield/GetServerPINPolicy"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <GetServerPINPolicy xmlns="http://www.cryptocard.com/blackshield/">
      <organization>string</organization>
    </GetServerPINPolicy>
  </soap:Body>
</soap:Envelope>

Response:

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <GetServerPINPolicyResponse xmlns="http://www.cryptocard.com/blackshield/">
      <GetServerPINPolicyResult>
        <ChangePINOnFirstReq>boolean</ChangePINOnFirstReq>
        <ForceRandomPIN>boolean</ForceRandomPIN>
        <MinLength>int</MinLength>
        <MaxLength>int</MaxLength>
        <RandomPINLength>int</RandomPINLength>
        <Complexity>NONE or ALPHANUMERIC or STRONG_ALPHANUMERIC or STRONG_NON_ALPHANUM or DECIMAL</Complexity>
        <ChangePeriod>int</ChangePeriod>
        <MaxChangeAttempts>int</MaxChangeAttempts>
        <UseServerSidePIN>boolean</UseServerSidePIN>
        <PINAfterOTP>boolean</PINAfterOTP>
      </GetServerPINPolicyResult>
    </GetServerPINPolicyResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2 sample

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

Request:

POST /bsidca/BSIDCA.asmx HTTP/1.1
Host: cloud.safenet-inc.com
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <GetServerPINPolicy xmlns="http://www.cryptocard.com/blackshield/">
      <organization>string</organization>
    </GetServerPINPolicy>
  </soap12:Body>
</soap12:Envelope>

Response:

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <GetServerPINPolicyResponse xmlns="http://www.cryptocard.com/blackshield/">
      <GetServerPINPolicyResult>
        <ChangePINOnFirstReq>boolean</ChangePINOnFirstReq>
        <ForceRandomPIN>boolean</ForceRandomPIN>
        <MinLength>int</MinLength>
        <MaxLength>int</MaxLength>
        <RandomPINLength>int</RandomPINLength>
        <Complexity>NONE or ALPHANUMERIC or STRONG_ALPHANUMERIC or STRONG_NON_ALPHANUM or DECIMAL</Complexity>
        <ChangePeriod>int</ChangePeriod>
        <MaxChangeAttempts>int</MaxChangeAttempts>
        <UseServerSidePIN>boolean</UseServerSidePIN>
        <PINAfterOTP>boolean</PINAfterOTP>
      </GetServerPINPolicyResult>
    </GetServerPINPolicyResponse>
  </soap12:Body>
</soap12:Envelope>

HTTP GET sample

The following is a sample HTTP GET request and response. The placeholders shown need to be replaced with actual values.

Request:

GET /bsidca/BSIDCA.asmx/GetServerPINPolicy?organization=string HTTP/1.1
Host: cloud.safenet-inc.com

Response:

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<ServerPINPolicy xmlns="http://www.cryptocard.com/blackshield/">
  <ChangePINOnFirstReq>boolean</ChangePINOnFirstReq>
  <ForceRandomPIN>boolean</ForceRandomPIN>
  <MinLength>int</MinLength>
  <MaxLength>int</MaxLength>
  <RandomPINLength>int</RandomPINLength>
  <Complexity>NONE or ALPHANUMERIC or STRONG_ALPHANUMERIC or STRONG_NON_ALPHANUM or DECIMAL</Complexity>
  <ChangePeriod>int</ChangePeriod>
  <MaxChangeAttempts>int</MaxChangeAttempts>
  <UseServerSidePIN>boolean</UseServerSidePIN>
  <PINAfterOTP>boolean</PINAfterOTP>
</ServerPINPolicy>

HTTP POST sample

The following is a sample HTTP POST request and response. The placeholders shown need to be replaced with actual values.

Request:

POST /bsidca/BSIDCA.asmx/GetServerPINPolicy HTTP/1.1
Host: cloud.safenet-inc.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length

organization=string

Response:

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<ServerPINPolicy xmlns="http://www.cryptocard.com/blackshield/">
  <ChangePINOnFirstReq>boolean</ChangePINOnFirstReq>
  <ForceRandomPIN>boolean</ForceRandomPIN>
  <MinLength>int</MinLength>
  <MaxLength>int</MaxLength>
  <RandomPINLength>int</RandomPINLength>
  <Complexity>NONE or ALPHANUMERIC or STRONG_ALPHANUMERIC or STRONG_NON_ALPHANUM or DECIMAL</Complexity>
  <ChangePeriod>int</ChangePeriod>
  <MaxChangeAttempts>int</MaxChangeAttempts>
  <UseServerSidePIN>boolean</UseServerSidePIN>
  <PINAfterOTP>boolean</PINAfterOTP>
</ServerPINPolicy>

SetTokenPIN

SetTokenPIN(System.String,System.String,System.Boolean,System.String,System.Boolean,System.String)

Set a token's server side PIN, optionally requiring a PIN change.

Parameters

Param: serial: Serial of the token to set the PIN for

Param: newPIN: The new PIN

Param: changeOnFirstUse: True if the user much change it on first use

Param: comment: Comment to attach to the token

Param: notifySMSUsers: True if you want to notify an SMS token user that their PIN has changed

Param: organization: Account

Returns

success	Successfully revoked a static password
fail	Failed to revoke a static password
complexityFail	New PIN to set does not meet the server side PIN complexity requirements.
error	Revoked the token but failed to revoke the static password

SOAP 1.1 sample

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

Request:

POST /bsidca/BSIDCA.asmx HTTP/1.1
Host: cloud.safenet-inc.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.cryptocard.com/blackshield/SetTokenPIN"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
    <SetTokenPIN xmlns="http://www.cryptocard.com/blackshield/">
    <serial>string</serial>
    <newPIN>string</newPIN>
    <changeOnFirstUse>boolean</changeOnFirstUse>
    <comment>string</comment>
    <notifySMSUsers>boolean</notifySMSUsers>
    <organization>string</organization>
    </SetTokenPIN>
</soap:Body>
</soap:Envelope>

Response:

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
    <SetTokenPINResponse xmlns="http://www.cryptocard.com/blackshield/">
    <SetTokenPINResult>success or fail or complexityFail or error</SetTokenPINResult>
    </SetTokenPINResponse>
</soap:Body>
</soap:Envelope>

SOAP 1.2 sample

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

Request:

POST /bsidca/BSIDCA.asmx HTTP/1.1
Host: cloud.safenet-inc.com
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
    <SetTokenPIN xmlns="http://www.cryptocard.com/blackshield/">
    <serial>string</serial>
    <newPIN>string</newPIN>
    <changeOnFirstUse>boolean</changeOnFirstUse>
    <comment>string</comment>
    <notifySMSUsers>boolean</notifySMSUsers>
    <organization>string</organization>
    </SetTokenPIN>
</soap12:Body>
</soap12:Envelope>

Response:

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
    <SetTokenPINResponse xmlns="http://www.cryptocard.com/blackshield/">
    <SetTokenPINResult>success or fail or complexityFail or error</SetTokenPINResult>
    </SetTokenPINResponse>
</soap12:Body>
</soap12:Envelope>

HTTP GET sample

The following is a sample HTTP GET request and response. The placeholders shown need to be replaced with actual values.

Request:

GET /bsidca/BSIDCA.asmx/SetTokenPIN?serial=string&newPIN=string&changeOnFirstUse=string&comment=string&notifySMSUsers=string&organization=string HTTP/1.1
Host: cloud.safenet-inc.com

Response:

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<newPINResult xmlns="http://www.cryptocard.com/blackshield/">success or fail or complexityFail or error</newPINResult>

HTTP POST sample

The following is a sample HTTP POST request and response. The placeholders shown need to be replaced with actual values.

Request:

POST /bsidca/BSIDCA.asmx/SetTokenPIN HTTP/1.1
Host: cloud.safenet-inc.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length

serial=string&newPIN=string&changeOnFirstUse=string&comment=string&notifySMSUsers=string&organization=string

Response:

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<newPINResult xmlns="http://www.cryptocard.com/blackshield/">success or fail or complexityFail or error</newPINResult>